cs-serlefin-sapi icon

cs-serlefin-sapi

1.0.x
(0 reviews)

📘 Documentación de la API - cs-serlefin-sapi

Esta sección describe los atributos y uso del servicio API cs-serlefin-sapi.

💂️ Información Base

  • Título de la API: cs-serlefin-sapi
  • Versión: v1
  • URL Base: https://cs-serlefin-sapi-{env}-v1.us-e1.cloudhub.io/api/Reemplaza {env} con:
    • dev (Desarrollo)
    • qa (Aseguramiento de Calidad)
    • prod (Producción)

🔑 Autenticación

Encabezados Requeridos

EncabezadoTipoDescripción
AuthorizationStringToken Bearer en el formato Bearer {{API_KEY}}
client_idStringIdentificador único para clientes de API
  • Authorization
    • Longitud: 36 - 37 caracteres
    • Ejemplo: Bearer abcdefghijklmnopqrstuvwxyz1234567890
  • client_id
    • Longitud: 32 - 36 caracteres
    • Ejemplo: 123e4567-e89b-12d3-a456-426614174000

📌 Estos encabezados son requeridos en todas las solicitudes.

✨ Endpoint: Ejecutar Operaciones de Servicio

POST /services

  • Descripción: Ejecuta operaciones de servicio basadas en código, filtro o nombre.

Cuerpo de Solicitud

{
  "operationType": "string (requerido, opciones: 'code', 'filter', 'name')",
  "operationCode": "string (opcional, para tipo 'code')",
  "operationFilter": "string (opcional, para tipo 'filter')",
  "operationName": "string (opcional, para tipo 'name')"
}

Cuerpo de Respuesta

Retorna un resultado detallado de la operación ejecutada.

🔒 Endpoint: Ejecutar Servicio por Código

POST /services-by-code

  • Descripción: Ejecuta una operación de servicio por su código.

Cuerpo de Solicitud

{
  "operationCode": "string (requerido)"
}

Cuerpo de Respuesta

Retorna una respuesta detallada para la operación basada en código.

🔐 Endpoint: Ejecutar Operaciones de Proveedor

POST /providers

  • Descripción: Ejecuta varias operaciones de proveedor (filtro, código, texto, etc.).

Cuerpo de Solicitud

{
  "providerType": "string (requerido, opciones: 'filter', 'code', 'text')",
  "filterCriteria": "string (requerido para tipo 'filter')",
  "operationCode": "string (requerido para tipo 'code')",
  "operationText": "string (requerido para tipo 'text')"
}

Cuerpo de Respuesta

Retorna un resultado detallado de la operación de proveedor ejecutada.

🔑 Endpoint: Recuperar Usuarios Proveedores

GET /providers-users

  • Descripción: Recupera datos de usuario proveedor.

Parámetros de Consulta

ParámetroTipoDescripciónRequerido
networkUserStringID de usuario de red (opcional)No
documentTypeIdStringID de tipo de documentoSí
documentStringNúmero de documentoSí

Cuerpo de Respuesta

Retorna una lista de datos de usuario proveedor.

✨ Endpoint: Autenticar Usuarios Proveedores

POST /authenticate-providers-users

  • Descripción: Autentica usuarios proveedores.

Cuerpo de Solicitud

{
  "providerId": "string (requerido)",
  "userId": "string (requerido)"
}

Cuerpo de Respuesta

Retorna estado de autenticación y detalles del usuario.

📝 Otros Endpoints

EndpointDescripción
POST /services-by-codeEjecuta una operación de servicio por su código.
POST /servicesEjecuta operaciones de servicio por código, filtro o nombre.
POST /providersEjecuta varias operaciones de proveedor.
GET /providers-usersRecupera datos de usuario proveedor.
POST /authenticate-providers-usersAutentica usuarios proveedores.

📎 Consulta los archivos de ejemplo asociados para esquemas detallados:
- /examples/requests/
- /examples/responses/

📊 Parámetros Comunes

ParámetroTipoDescripciónRequerido
client_idStringIdentificador del cliente de API✅
AuthorizationStringToken Bearer para autenticación✅

🔐 Esquemas de Seguridad

Aplicación de Client ID

CampoTipoRequeridoLongitudRegex
client_idStringSí32 - 36[a-zA-Z0-9]
client_secretStringSí32 - 64[a-zA-Z0-9]

OAuth 2.0

CampoTipoRequeridoLongitudRegex
AuthorizationStringSí36 - 37[a-zA-Z0-9-_.]

⚠️ Códigos de Error

CódigoDescripciónSolución Sugerida
400Solicitud IncorrectaRevisar sintaxis de solicitud y parámetros
401No AutorizadoValidar credenciales de autenticación
404No EncontradoConfirmar la URL del endpoint
500Error Interno del ServidorReintentar o contactar soporte técnico

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

  • Documentación actualizada por última vez: Septiembre 2025
  • Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-serlefin-sapi

Reviews